<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>usb: XUsb Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">usb
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_usb.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XUsb Struct Reference<div class="ingroups"><a class="el" href="group__usb__v5__0.html">Usb_v5_0</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_usb.html" title="The XUsb driver instance data. ">XUsb</a> driver instance data.  
 <a href="struct_x_usb.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ac9eb29e8f2372f88e570357da004e189"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_usb___config.html">XUsb_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb.html#ac9eb29e8f2372f88e570357da004e189">Config</a></td></tr>
<tr class="memdesc:ac9eb29e8f2372f88e570357da004e189"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration structure.  <a href="#ac9eb29e8f2372f88e570357da004e189">More...</a><br /></td></tr>
<tr class="separator:ac9eb29e8f2372f88e570357da004e189"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a260e5c141d966b04f28b67c1c9bb6d07"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb.html#a260e5c141d966b04f28b67c1c9bb6d07">IsReady</a></td></tr>
<tr class="memdesc:a260e5c141d966b04f28b67c1c9bb6d07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is initialized and ready.  <a href="#a260e5c141d966b04f28b67c1c9bb6d07">More...</a><br /></td></tr>
<tr class="separator:a260e5c141d966b04f28b67c1c9bb6d07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82aaf4839aaa1cc58a1dde0e2dd7c2b4"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb.html#a82aaf4839aaa1cc58a1dde0e2dd7c2b4">USBAddress</a></td></tr>
<tr class="memdesc:a82aaf4839aaa1cc58a1dde0e2dd7c2b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The USB address of the device.  <a href="#a82aaf4839aaa1cc58a1dde0e2dd7c2b4">More...</a><br /></td></tr>
<tr class="separator:a82aaf4839aaa1cc58a1dde0e2dd7c2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69fc81451351e4418bfe14f9fae4fb40"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb.html#a69fc81451351e4418bfe14f9fae4fb40">EndPointOffset</a> [<a class="el" href="group__usb__v5__0.html#gac10c01aa71b29e898218eb4ffb61bea5">XUSB_MAX_ENDPOINTS</a>]</td></tr>
<tr class="memdesc:a69fc81451351e4418bfe14f9fae4fb40"><td class="mdescLeft">&#160;</td><td class="mdescRight">End point Offsets.  <a href="#a69fc81451351e4418bfe14f9fae4fb40">More...</a><br /></td></tr>
<tr class="separator:a69fc81451351e4418bfe14f9fae4fb40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3ca87faf1aa1caaa6fa6e6f7c3e9267"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_usb___device_config.html">XUsb_DeviceConfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb.html#ab3ca87faf1aa1caaa6fa6e6f7c3e9267">DeviceConfig</a></td></tr>
<tr class="memdesc:ab3ca87faf1aa1caaa6fa6e6f7c3e9267"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following structure holds the configuration for the controller.  <a href="#ab3ca87faf1aa1caaa6fa6e6f7c3e9267">More...</a><br /></td></tr>
<tr class="separator:ab3ca87faf1aa1caaa6fa6e6f7c3e9267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac90559e35c0a6d0f0d77843801455f54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usb__v5__0.html#ga64403da3a365ae35df1c860942c17358">XUsb_IntrHandlerFunc</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_usb.html#ac90559e35c0a6d0f0d77843801455f54">HandlerFunc</a></td></tr>
<tr class="memdesc:ac90559e35c0a6d0f0d77843801455f54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callbacks and callback references.  <a href="#ac90559e35c0a6d0f0d77843801455f54">More...</a><br /></td></tr>
<tr class="separator:ac90559e35c0a6d0f0d77843801455f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_usb.html" title="The XUsb driver instance data. ">XUsb</a> driver instance data. </p>
<p>The user is required to allocate a variable of this type for every USB device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ac9eb29e8f2372f88e570357da004e189"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9eb29e8f2372f88e570357da004e189">&#9670;&nbsp;</a></span>Config</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_usb___config.html">XUsb_Config</a> XUsb::Config</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configuration structure. </p>

<p class="reference">Referenced by <a class="el" href="xusb__cp9_8h.html#ac4a19eadcf18a8eaae15eec7bd617c55">Chapter9()</a>, <a class="el" href="xusb__storage_8h.html#a3b40155d0d9fa44133905dd9f6f02ee7">InitUsbInterface()</a>, <a class="el" href="xusb__cp9_8h.html#a0e70dcdbdf3db1095a5b1b4128041618">SetupControlWriteStatusStage()</a>, <a class="el" href="group__usb__v5__0.html#gaeab13bf4d5ed84b5b9e0c1c651f50aaa">XUsb_CfgInitialize()</a>, <a class="el" href="group__usb__v5__0.html#ga1702a7ff1e0627217bdf4d4429a76f1c">XUsb_DmaReset()</a>, <a class="el" href="group__usb__v5__0.html#ga7255a426eb2c5a1c475fedaf265b7db2">XUsb_DmaTransfer()</a>, <a class="el" href="group__usb__v5__0.html#ga265f540fba1a12b0e310052d4cfa5a2d">XUsb_EpConfigure()</a>, <a class="el" href="group__usb__v5__0.html#ga143b99da38f8de7e4d0f5cee108fc797">XUsb_EpDataRecv()</a>, <a class="el" href="group__usb__v5__0.html#gabf09f948bc604c279cb0a12bba14057b">XUsb_EpDataSend()</a>, <a class="el" href="group__usb__v5__0.html#ga82e240bb1af0cc302cd2c8b7363161d8">XUsb_EpDisable()</a>, <a class="el" href="group__usb__v5__0.html#gadc3661c9581f9dea4b01873cbaff31a8">XUsb_EpEnable()</a>, <a class="el" href="group__usb__v5__0.html#ga8af69babadc9c361e05afca4e350b918">XUsb_EpIsoTransferConfigure()</a>, <a class="el" href="group__usb__v5__0.html#gab38009aad2e0011e0bd392f064edeec7">XUsb_EpStall()</a>, <a class="el" href="group__usb__v5__0.html#ga30a3f5338e5938d9efc1e843c38e9d78">XUsb_EpUnstall()</a>, <a class="el" href="group__usb__v5__0.html#ga2bfe41baf4bcdaae0da439ec758de24e">XUsb_GetFrameNum()</a>, <a class="el" href="group__usb__v5__0.html#ga6a9e88138c012fcfa32717eeaab1e5b1">XUsb_IntrDisable()</a>, <a class="el" href="group__usb__v5__0.html#gafcd3e91e72783087a0c6902724b8087f">XUsb_IntrEnable()</a>, <a class="el" href="group__usb__v5__0.html#gaf1806727cc17345c2b9a900804e3b322">XUsb_ReadErrorCounters()</a>, <a class="el" href="group__usb__v5__0.html#gaa2f7958d25023d2ed18cfaabfb2baa0f">XUsb_SetDeviceAddress()</a>, <a class="el" href="group__usb__v5__0.html#ga4d5a367719f199ad49b9020f0fdd22ab">XUsb_SetTestMode()</a>, <a class="el" href="group__usb__v5__0.html#ga59efbc6f5496ad21e48659c5a7090425">XUsb_SieReset()</a>, <a class="el" href="group__usb__v5__0.html#ga4708ca8b9ca477b58d7da7db3f1be308">XUsb_Start()</a>, <a class="el" href="group__usb__v5__0.html#ga53f7e5c356dbe880560a6eb5942a74d6">XUsb_Stop()</a>, <a class="el" href="group__usb__v5__0.html#ga9d1522d41344290899ebbf1a40824697">XUsb_UlpiPhyReadRegister()</a>, and <a class="el" href="group__usb__v5__0.html#ga5464e6b0871344e088f252872554b7bb">XUsb_UlpiPhyWriteRegister()</a>.</p>

</div>
</div>
<a id="ab3ca87faf1aa1caaa6fa6e6f7c3e9267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3ca87faf1aa1caaa6fa6e6f7c3e9267">&#9670;&nbsp;</a></span>DeviceConfig</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_usb___device_config.html">XUsb_DeviceConfig</a> XUsb::DeviceConfig</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following structure holds the configuration for the controller. </p>
<p>They are initialized using the <a class="el" href="group__usb__v5__0.html#ga9c50c0ee6d36d4b87a40018c2ad0fd25" title="This function initializes USB End points. ">XUsb_ConfigureDevice()</a> function call. </p>

<p class="reference">Referenced by <a class="el" href="xusb__storage_8h.html#a3b40155d0d9fa44133905dd9f6f02ee7">InitUsbInterface()</a>, <a class="el" href="xusb__dma__intr__storage_8c.html#a20c10bb6c0fae679e5f4309d4f82e8a1">ReadTransfer()</a>, <a class="el" href="xusb__cp9_8h.html#a0e70dcdbdf3db1095a5b1b4128041618">SetupControlWriteStatusStage()</a>, <a class="el" href="group__usb__v5__0.html#gaeab13bf4d5ed84b5b9e0c1c651f50aaa">XUsb_CfgInitialize()</a>, <a class="el" href="group__usb__v5__0.html#ga9c50c0ee6d36d4b87a40018c2ad0fd25">XUsb_ConfigureDevice()</a>, <a class="el" href="group__usb__v5__0.html#ga143b99da38f8de7e4d0f5cee108fc797">XUsb_EpDataRecv()</a>, <a class="el" href="group__usb__v5__0.html#gabf09f948bc604c279cb0a12bba14057b">XUsb_EpDataSend()</a>, and <a class="el" href="group__usb__v5__0.html#gae7fef0669e6d6094cc2af067195cc04d">XUsb_EpSetHandler()</a>.</p>

</div>
</div>
<a id="a69fc81451351e4418bfe14f9fae4fb40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69fc81451351e4418bfe14f9fae4fb40">&#9670;&nbsp;</a></span>EndPointOffset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XUsb::EndPointOffset[<a class="el" href="group__usb__v5__0.html#gac10c01aa71b29e898218eb4ffb61bea5">XUSB_MAX_ENDPOINTS</a>]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>End point Offsets. </p>

<p class="reference">Referenced by <a class="el" href="xusb__cp9_8h.html#a0e70dcdbdf3db1095a5b1b4128041618">SetupControlWriteStatusStage()</a>, <a class="el" href="group__usb__v5__0.html#gaeab13bf4d5ed84b5b9e0c1c651f50aaa">XUsb_CfgInitialize()</a>, <a class="el" href="group__usb__v5__0.html#ga265f540fba1a12b0e310052d4cfa5a2d">XUsb_EpConfigure()</a>, <a class="el" href="group__usb__v5__0.html#gabf09f948bc604c279cb0a12bba14057b">XUsb_EpDataSend()</a>, <a class="el" href="group__usb__v5__0.html#ga82e240bb1af0cc302cd2c8b7363161d8">XUsb_EpDisable()</a>, <a class="el" href="group__usb__v5__0.html#gadc3661c9581f9dea4b01873cbaff31a8">XUsb_EpEnable()</a>, <a class="el" href="group__usb__v5__0.html#ga8af69babadc9c361e05afca4e350b918">XUsb_EpIsoTransferConfigure()</a>, <a class="el" href="group__usb__v5__0.html#gab38009aad2e0011e0bd392f064edeec7">XUsb_EpStall()</a>, and <a class="el" href="group__usb__v5__0.html#ga30a3f5338e5938d9efc1e843c38e9d78">XUsb_EpUnstall()</a>.</p>

</div>
</div>
<a id="ac90559e35c0a6d0f0d77843801455f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac90559e35c0a6d0f0d77843801455f54">&#9670;&nbsp;</a></span>HandlerFunc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__usb__v5__0.html#ga64403da3a365ae35df1c860942c17358">XUsb_IntrHandlerFunc</a> XUsb::HandlerFunc</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callbacks and callback references. </p>

<p class="reference">Referenced by <a class="el" href="group__usb__v5__0.html#gaeab13bf4d5ed84b5b9e0c1c651f50aaa">XUsb_CfgInitialize()</a>, and <a class="el" href="group__usb__v5__0.html#gada7caf770f82936ab7493b67d143b9a9">XUsb_IntrSetHandler()</a>.</p>

</div>
</div>
<a id="a260e5c141d966b04f28b67c1c9bb6d07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a260e5c141d966b04f28b67c1c9bb6d07">&#9670;&nbsp;</a></span>IsReady</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XUsb::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is initialized and ready. </p>

<p class="reference">Referenced by <a class="el" href="group__usb__v5__0.html#ga6fbf5a1ddbca576e8c1e7d235da878ab">XUsb_DmaIntrSetHandler()</a>, <a class="el" href="group__usb__v5__0.html#ga143b99da38f8de7e4d0f5cee108fc797">XUsb_EpDataRecv()</a>, <a class="el" href="group__usb__v5__0.html#gabf09f948bc604c279cb0a12bba14057b">XUsb_EpDataSend()</a>, <a class="el" href="group__usb__v5__0.html#ga82e240bb1af0cc302cd2c8b7363161d8">XUsb_EpDisable()</a>, <a class="el" href="group__usb__v5__0.html#gadc3661c9581f9dea4b01873cbaff31a8">XUsb_EpEnable()</a>, <a class="el" href="group__usb__v5__0.html#ga8af69babadc9c361e05afca4e350b918">XUsb_EpIsoTransferConfigure()</a>, <a class="el" href="group__usb__v5__0.html#gab38009aad2e0011e0bd392f064edeec7">XUsb_EpStall()</a>, <a class="el" href="group__usb__v5__0.html#ga30a3f5338e5938d9efc1e843c38e9d78">XUsb_EpUnstall()</a>, <a class="el" href="group__usb__v5__0.html#gaa2a8bba76c93470302e179d7c4d864ac">XUsb_ErrIntrSetHandler()</a>, <a class="el" href="group__usb__v5__0.html#ga2bfe41baf4bcdaae0da439ec758de24e">XUsb_GetFrameNum()</a>, <a class="el" href="group__usb__v5__0.html#ga6a9e88138c012fcfa32717eeaab1e5b1">XUsb_IntrDisable()</a>, <a class="el" href="group__usb__v5__0.html#gafcd3e91e72783087a0c6902724b8087f">XUsb_IntrEnable()</a>, <a class="el" href="group__usb__v5__0.html#gada7caf770f82936ab7493b67d143b9a9">XUsb_IntrSetHandler()</a>, <a class="el" href="group__usb__v5__0.html#gaa2f7958d25023d2ed18cfaabfb2baa0f">XUsb_SetDeviceAddress()</a>, <a class="el" href="group__usb__v5__0.html#ga4d5a367719f199ad49b9020f0fdd22ab">XUsb_SetTestMode()</a>, <a class="el" href="group__usb__v5__0.html#ga4708ca8b9ca477b58d7da7db3f1be308">XUsb_Start()</a>, <a class="el" href="group__usb__v5__0.html#ga53f7e5c356dbe880560a6eb5942a74d6">XUsb_Stop()</a>, and <a class="el" href="group__usb__v5__0.html#ga0573097a6ec999bac0f865dc18113df3">XUsb_UlpiIntrSetHandler()</a>.</p>

</div>
</div>
<a id="a82aaf4839aaa1cc58a1dde0e2dd7c2b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82aaf4839aaa1cc58a1dde0e2dd7c2b4">&#9670;&nbsp;</a></span>USBAddress</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XUsb::USBAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The USB address of the device. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
